<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html
    PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=9" />
    <meta name="generator" content="Doxygen 1.8.16" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>LEAF: tSNAC</title>
    <link href="tabs.css" rel="stylesheet" type="text/css" />
    <script type="text/javascript" src="jquery.js"></script>
    <script type="text/javascript" src="dynsections.js"></script>
    <script type="text/javascript" src="../js/iframeResizer.contentWindow.min.js"></script>
    <!-- <script src="/js/template.js"></script> -->
     <link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(function() { init_search(); });
/* @license-end */
</script> 
    <link href="doxygen.css" rel="stylesheet" type="text/css" />
    <link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
    <!-- <link rel="stylesheet" href="/css/tachyons.css" type="text/css" /> -->
</head>
<body class="bg-washed-green black-70 ph0 sans-serif" onload="iframeResizePipe()">
    <div>
        <!-- do not remove this div, it is closed by doxygen! -->
        <div id="titlearea">
            <table cellspacing="0" cellpadding="0">
                <tbody>
                    <tr>
                    </tr>
                </tbody>
            </table>
        </div>
        <!-- end header part -->
    </div>
</body>
</html><!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">tSNAC<div class="ingroups"><a class="el" href="group__analysis.html">Analysis</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Component of period detection algorithm from Katja Vetters <a href="http://www.katjaas.nl/helmholtz/helmholtz.html">http://www.katjaas.nl/helmholtz/helmholtz.html</a>.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga5f4005dba1c0470e84ae6bc6845c6d27"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tsnac.html#ga5f4005dba1c0470e84ae6bc6845c6d27">tSNAC_init</a> (tSNAC *const, int overlaparg, <a class="el" href="struct_l_e_a_f.html">LEAF</a> *const leaf)</td></tr>
<tr class="memdesc:ga5f4005dba1c0470e84ae6bc6845c6d27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize a tSNAC to the default mempool of a <a class="el" href="struct_l_e_a_f.html" title="Struct for an instance of LEAF.">LEAF</a> instance.  <a href="group__tsnac.html#ga5f4005dba1c0470e84ae6bc6845c6d27">More...</a><br /></td></tr>
<tr class="separator:ga5f4005dba1c0470e84ae6bc6845c6d27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9779c23ab83bf93c8df11a6b4982c0b2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tsnac.html#ga9779c23ab83bf93c8df11a6b4982c0b2">tSNAC_initToPool</a> (tSNAC *const, int overlaparg, tMempool *const)</td></tr>
<tr class="memdesc:ga9779c23ab83bf93c8df11a6b4982c0b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize a tSNAC to a specified mempool.  <a href="group__tsnac.html#ga9779c23ab83bf93c8df11a6b4982c0b2">More...</a><br /></td></tr>
<tr class="separator:ga9779c23ab83bf93c8df11a6b4982c0b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad7fc6ce1e80847dfcd9da75d4c734f12"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tsnac.html#gad7fc6ce1e80847dfcd9da75d4c734f12">tSNAC_free</a> (tSNAC *const)</td></tr>
<tr class="memdesc:gad7fc6ce1e80847dfcd9da75d4c734f12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free a tSNAC from its mempool.  <a href="group__tsnac.html#gad7fc6ce1e80847dfcd9da75d4c734f12">More...</a><br /></td></tr>
<tr class="separator:gad7fc6ce1e80847dfcd9da75d4c734f12"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab6a4ff9c52fb26d19f3bc4d080f91845"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tsnac.html#gab6a4ff9c52fb26d19f3bc4d080f91845">tSNAC_setOverlap</a> (tSNAC *s, int lap)</td></tr>
<tr class="separator:gab6a4ff9c52fb26d19f3bc4d080f91845"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3dbb9845079ebe1b3dbba647180a1168"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tsnac.html#ga3dbb9845079ebe1b3dbba647180a1168">tSNAC_setBias</a> (tSNAC *s, float bias)</td></tr>
<tr class="separator:ga3dbb9845079ebe1b3dbba647180a1168"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga777b3cb40c7dcb7826b0945358ffe1ec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tsnac.html#ga777b3cb40c7dcb7826b0945358ffe1ec">tSNAC_setMinRMS</a> (tSNAC *s, float rms)</td></tr>
<tr class="separator:ga777b3cb40c7dcb7826b0945358ffe1ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga71074b5888fe76260f3c1fae7e2aeec8"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tsnac.html#ga71074b5888fe76260f3c1fae7e2aeec8">tSNAC_getPeriod</a> (tSNAC *s)</td></tr>
<tr class="separator:ga71074b5888fe76260f3c1fae7e2aeec8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8568190ff50745df3b220f9f8dba3289"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tsnac.html#ga8568190ff50745df3b220f9f8dba3289">tSNAC_getFidelity</a> (tSNAC *s)</td></tr>
<tr class="separator:ga8568190ff50745df3b220f9f8dba3289"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Component of period detection algorithm from Katja Vetters <a href="http://www.katjaas.nl/helmholtz/helmholtz.html">http://www.katjaas.nl/helmholtz/helmholtz.html</a>. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga5f4005dba1c0470e84ae6bc6845c6d27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5f4005dba1c0470e84ae6bc6845c6d27">&#9670;&nbsp;</a></span>tSNAC_init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void tSNAC_init </td>
          <td>(</td>
          <td class="paramtype">tSNAC * const&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>overlaparg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_l_e_a_f.html">LEAF</a> *const&#160;</td>
          <td class="paramname"><em>leaf</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialize a tSNAC to the default mempool of a <a class="el" href="struct_l_e_a_f.html" title="Struct for an instance of LEAF.">LEAF</a> instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">snac</td><td>A pointer to the tSNAC to initialize. </td></tr>
    <tr><td class="paramname">overlap</td><td></td></tr>
    <tr><td class="paramname">leaf</td><td>A pointer to the leaf instance. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga9779c23ab83bf93c8df11a6b4982c0b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9779c23ab83bf93c8df11a6b4982c0b2">&#9670;&nbsp;</a></span>tSNAC_initToPool()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void tSNAC_initToPool </td>
          <td>(</td>
          <td class="paramtype">tSNAC * const&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>overlaparg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">tMempool * const&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialize a tSNAC to a specified mempool. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">snac</td><td>A pointer to the tSNAC to initialize. </td></tr>
    <tr><td class="paramname">overlap</td><td></td></tr>
    <tr><td class="paramname">mempool</td><td>A pointer to the tMempool to use. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gad7fc6ce1e80847dfcd9da75d4c734f12"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad7fc6ce1e80847dfcd9da75d4c734f12">&#9670;&nbsp;</a></span>tSNAC_free()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void tSNAC_free </td>
          <td>(</td>
          <td class="paramtype">tSNAC * const&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Free a tSNAC from its mempool. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">snac</td><td>A pointer to the tSNAC to free. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gab6a4ff9c52fb26d19f3bc4d080f91845"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab6a4ff9c52fb26d19f3bc4d080f91845">&#9670;&nbsp;</a></span>tSNAC_setOverlap()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void tSNAC_setOverlap </td>
          <td>(</td>
          <td class="paramtype">tSNAC *&#160;</td>
          <td class="paramname"><em>s</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>lap</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">snac</td><td>A pointer to the relevant tSNAC. </td></tr>
    <tr><td class="paramname">overlap</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga3dbb9845079ebe1b3dbba647180a1168"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3dbb9845079ebe1b3dbba647180a1168">&#9670;&nbsp;</a></span>tSNAC_setBias()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void tSNAC_setBias </td>
          <td>(</td>
          <td class="paramtype">tSNAC *&#160;</td>
          <td class="paramname"><em>s</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>bias</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">snac</td><td>A pointer to the relevant tSNAC. </td></tr>
    <tr><td class="paramname">bias</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga777b3cb40c7dcb7826b0945358ffe1ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga777b3cb40c7dcb7826b0945358ffe1ec">&#9670;&nbsp;</a></span>tSNAC_setMinRMS()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void tSNAC_setMinRMS </td>
          <td>(</td>
          <td class="paramtype">tSNAC *&#160;</td>
          <td class="paramname"><em>s</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>rms</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">snac</td><td>A pointer to the relevant tSNAC. </td></tr>
    <tr><td class="paramname">rms</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga71074b5888fe76260f3c1fae7e2aeec8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga71074b5888fe76260f3c1fae7e2aeec8">&#9670;&nbsp;</a></span>tSNAC_getPeriod()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float tSNAC_getPeriod </td>
          <td>(</td>
          <td class="paramtype">tSNAC *&#160;</td>
          <td class="paramname"><em>s</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">snac</td><td>A pointer to the relevant tSNAC. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The detected period of the input </dd></dl>

</div>
</div>
<a id="ga8568190ff50745df3b220f9f8dba3289"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8568190ff50745df3b220f9f8dba3289">&#9670;&nbsp;</a></span>tSNAC_getFidelity()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float tSNAC_getFidelity </td>
          <td>(</td>
          <td class="paramtype">tSNAC *&#160;</td>
          <td class="paramname"><em>s</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">snac</td><td>A pointer to the relevant tSNAC. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The periodic fidelity of the input ￼￼￼ </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
</body>
</html>
